<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
        <head><title>class CalendarQuery in com.google.gdata.calendar</title>
        <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.1.r14655-b20080415113712)" name="generator"></meta><link href="../../../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../../../script.js"></script>
        </head>
        <body onload="init()">
        <table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">GData Scala Client Library Documentation</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
        
      <div class="entity">
        <a href="../../../../com/google/gdata/calendar$package.html" target="_self">com.google.gdata.calendar</a>
        <br></br>
        <span class="entity">class  CalendarQuery</span>
      </div><hr></hr>
      <div class="source">
        [source: <a href="" class="com/google/gdata/calendar/CalendarQuery"><code>com/google/gdata/calendar/CalendarQuery.scala</code></a>]
      </div><hr></hr>
      <a name="CalendarQuery"></a><dl>
      <dt>
        
        <code></code>
        <code>class</code>
        <em>CalendarQuery</em>
      </dt>
      <dd><code> extends </code><a href="../../../../com/google/gdata/Query.html" target="_self">Query</a></dd>
    </dl>
      <dl><dd>A calendar query. It adds methods for specifying whether recurring events should
 be expanded, which events should be returned, the timezone for the returned times, etc.</dd></dl>
      <dl></dl>
    
      

<table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Values and Variables inherited from <a href="../../../../com/google/gdata/Query.html" target="_self">Query</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="../../../../com/google/gdata/Query.html#searchQuery" target="_self">searchQuery</a>
        </td></tr>
      </table>
<table summary="" cellpadding="3" class="member">
      <tr><td class="title" colspan="2">Method Summary</td></tr>
      <tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#expandEnd%28com.google.gdata.data.util.DateTime%29" target="_self">expandEnd</a></em>
        (<em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>End date for recurrent event expansion (exclusive).</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#expandRecurrence%28com.google.gdata.data.util.DateTime%2Ccom.google.gdata.data.util.DateTime%29" target="_self">expandRecurrence</a></em>
        (<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>, <em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Interval for which recurring events are expanded. The beginning of the interval 
   is inclusive, the end is exclusive.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#expandStart%28com.google.gdata.data.util.DateTime%29" target="_self">expandStart</a></em>
        (<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Start date for recurrent event expansion (inclusive).</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#futureEvents%28Boolean%29" target="_self">futureEvents</a></em>
        (<em>b</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Request all future events.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#order%28String%29" target="_self">order</a></em>
        (<em>direction</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Specifies direction of sorting. Valid values are 'ascend', 'ascending', 'a' and
   'descend', 'descending', 'd'.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#orderBy%28String%29" target="_self">orderBy</a></em>
        (<em>ordering</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Specifies how to sort events in the search result set. Valid values for this 
   parameter are 'lastmodified' and 'starttime'. Default is 'lastmodified'.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#singleEvents%28Boolean%29" target="_self">singleEvents</a></em>
        (<em>b</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Indicates whether recurring events should be expanded or represented as a single event.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#startBetween%28com.google.gdata.data.util.DateTime%2Ccom.google.gdata.data.util.DateTime%29" target="_self">startBetween</a></em>
        (<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>, <em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Return events who start in the given interval. The interval is inclusive at the
   beginning and exclusive at the end.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#startMax%28com.google.gdata.data.util.DateTime%29" target="_self">startMax</a></em>
        (<em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Together with start-min creates a timespan such that only events that are 
   within the timespan are returned. If not specified, default start-max is 
   2031-01-01. This bound is exclusive.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#startMin%28com.google.gdata.data.util.DateTime%29" target="_self">startMin</a></em>
        (<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>Together with start-max creates a timespan such that only events that are 
   within the timespan are returned. If not specified, default start-min is 
   1970-01-01. This bound is inclusive.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../../com/google/gdata/calendar/CalendarQuery.html#timeZone%28String%29" target="_self">timeZone</a></em>
        (<em>tz</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
        
        <div>The current timezone. If not specified, times are returned in UTC.
   Replace all spaces with underscores (e.g. "ctz=America/Los_Angeles").</div>
      </td>
    </tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="../../../../com/google/gdata/Query.html" target="_self">Query</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="../../../../com/google/gdata/Query.html#%26%28com.google.gdata.SearchQuery%29" target="_self">&amp;</a>, <a href="../../../../com/google/gdata/Query.html#%7C%28com.google.gdata.SearchQuery%29" target="_self">|</a>, <a href="../../../../com/google/gdata/Query.html#%2F%28com.google.gdata.CategoryQuery%29" target="_self">/</a>, <a href="../../../../com/google/gdata/Query.html#%2F%28String%29" target="_self">/</a>, <a href="../../../../com/google/gdata/Query.html#matching%28com.google.gdata.SearchQuery%29" target="_self">matching</a>, <a href="../../../../com/google/gdata/Query.html#mkUrl%28String%29" target="_self">mkUrl</a>, <a href="../../../../com/google/gdata/Query.html#searchName" target="_self">searchName</a>, <a href="../../../../com/google/gdata/Query.html#addParam%28String%2CString%29" target="_self">addParam</a>, <a href="../../../../com/google/gdata/Query.html#author%28String%29" target="_self">author</a>, <a href="../../../../com/google/gdata/Query.html#alt%28String%29" target="_self">alt</a>, <a href="../../../../com/google/gdata/Query.html#updatedMin%28com.google.gdata.data.util.DateTime%29" target="_self">updatedMin</a>, <a href="../../../../com/google/gdata/Query.html#updatedMax%28com.google.gdata.data.util.DateTime%29" target="_self">updatedMax</a>, <a href="../../../../com/google/gdata/Query.html#publishedMin%28com.google.gdata.data.util.DateTime%29" target="_self">publishedMin</a>, <a href="../../../../com/google/gdata/Query.html#publishedMax%28com.google.gdata.data.util.DateTime%29" target="_self">publishedMax</a>, <a href="../../../../com/google/gdata/Query.html#startIndex%28Int%29" target="_self">startIndex</a>, <a href="../../../../com/google/gdata/Query.html#maxResults%28Int%29" target="_self">maxResults</a>
        </td></tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a>
        </td></tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a>
        </td></tr>
      </table>


      


<table summary="" cellpadding="3" class="member-detail">
          <tr><td class="title">Method Details</td></tr>
        </table><div><a name="orderBy%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>orderBy</em>(<em>ordering</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Specifies how to sort events in the search result set. Valid values for this 
   parameter are 'lastmodified' and 'starttime'. Default is 'lastmodified'.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="futureEvents%28Boolean%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>futureEvents</em>(<em>b</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Request all future events.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="expandRecurrence%28com.google.gdata.data.util.DateTime%2Ccom.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>expandRecurrence</em>(<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>, <em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Interval for which recurring events are expanded. The beginning of the interval 
   is inclusive, the end is exclusive.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="expandStart%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>expandStart</em>(<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Start date for recurrent event expansion (inclusive).</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="expandEnd%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>expandEnd</em>(<em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>End date for recurrent event expansion (exclusive).</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="singleEvents%28Boolean%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>singleEvents</em>(<em>b</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Boolean.html" target="_self">Boolean</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Indicates whether recurring events should be expanded or represented as a single event.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="order%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>order</em>(<em>direction</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Specifies direction of sorting. Valid values are 'ascend', 'ascending', 'a' and
   'descend', 'descending', 'd'.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="startMin%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>startMin</em>(<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Together with start-max creates a timespan such that only events that are 
   within the timespan are returned. If not specified, default start-min is 
   1970-01-01. This bound is inclusive.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="startMax%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>startMax</em>(<em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Together with start-min creates a timespan such that only events that are 
   within the timespan are returned. If not specified, default start-max is 
   2031-01-01. This bound is exclusive.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="startBetween%28com.google.gdata.data.util.DateTime%2Ccom.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>startBetween</em>(<em>start</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>, <em>end</em> : <a href="../../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return events who start in the given interval. The interval is inclusive at the
   beginning and exclusive at the end.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="timeZone%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>timeZone</em>(<em>tz</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>The current timezone. If not specified, times are returned in UTC.
   Replace all spaces with underscores (e.g. "ctz=America/Los_Angeles").</dd></dl>
      <dl></dl>
    <hr></hr></div>


    <hr></hr>
        <table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">GData Scala Client Library Documentation</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
      </body>
      </html>